home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / qprn102.zip / READER.DOC < prev    next >
Text File  |  1993-04-25  |  12KB  |  232 lines
  1.   QWKPRUNE can be used as a "preprocessor" for many QWK readers.  If the
  2.   reader lets you replace the name of your unpacker with a batch file, you
  3.   should be able to use QWKPRUNE in this manner.  If it doesn't, you may be
  4.   able to use PARM.EXE to call a batch file.
  5.  
  6.   Create a prune file for each BBS you want to filter messages from.  Each
  7.   prune file must be named BBSID.PRN.  The files must be located in the
  8.   same directory as QWKPRUNE.EXE, unless you set the PRUNE option in the
  9.   configuration file, or specify a directory on the line that calls
  10.   QWKPRUNE.  BBSID is the name the board's mail door gives to QWK packets.
  11.   So if a BBS creates packets named ABC.QWK, the prune file should be named
  12.   ABC.PRN.  QWKPRUNE reads the BBSID from CONTROL.DAT, so it can find the
  13.   correct prune file even if a packet has been renamed.  If there's no
  14.   prune file for a BBS, (R), Re:, and Re : prefixes and leading whitespace
  15.   will still be stripped from the subject lines of the messages.
  16.  
  17.   Extract the correct batch file from the distribution archive, place it in
  18.   the directory where your reader is located, and edit it to fit your
  19.   configuration.  If your reader isn't listed below, try using UNPACK.BAT.
  20.   Once you have the batch file working, delete the REM statements to speed
  21.   up processing.
  22.   
  23.   I've tested this with SLMR/OLX 2.x, EZ-RDR 1.37+, DeLuxe 1.2x, 1stReader
  24.   1.01, KingQWK 1.00 and 1.05, QWKMerge 1.05, Jabber 1.1+, Session Manager
  25.   1.06, MegaMail 2.10, Power-QWK 2.14, Speed Read 1.20, and Blue Wave 2.1x.
  26.  
  27.  
  28.                                 SLMR/OLX 2.x
  29.                                    -----
  30.   Use UNPACK.BAT.  SLMR and OLX change to their work directory, so there's
  31.   no need to specify its location in the batch file. SLMR and OLX can call
  32.   batch files directly.
  33.  
  34.                                 EZ-RDR 1.37+
  35.                                    -----
  36.   Use UNPACK.BAT.  EZ-RDR creates a directory called WORK below the EZ-RDR
  37.   directory defined in its configuration.  It changes to this directory, so
  38.   references to the work directory can be removed from the batch file.
  39.   EZ-RDR doesn't remember what directory it changed from, so you'll have
  40.   to give a path to UNPACK.BAT when reconfiguring EZ.  EZ-RDR can call
  41.   batch files directly.
  42.  
  43.   When EZ-RDR saves your place in a QWK, it alters the .NDX files and
  44.   re-archives them, but doesn't re-archive MESSAGES.DAT.  As a matter of
  45.   fact, it appears to delete MESSAGES.DAT before inserting the bookmarks
  46.   into the QWK packet.  If you want to have EZ-RDR save your place, insert
  47.   the line "copy messages.dat messages.bak" (without quotes) into
  48.   UNPACK.BAT just below the line that runs QWKPRUNE.  You'll also need to
  49.   reconfigure EZ-RDR to use EZ-PACK.BAT to call your packer.
  50.  
  51.   Running a batch file while swapped to EMS may interfere with the display
  52.   in EZ-RDR 1.37's DOS window.  It appears that the QWK packet is still
  53.   processed correctly, you just can't follow the process.
  54.  
  55.                                 DeLuxe 1.2x
  56.                                    -----
  57.   Use UNPACK.BAT.  DeLuxe doesn't change to the Q-WORK directory, so you'll
  58.   have to specify its location in the batch file.  DeLuxe can call batch
  59.   files directly.  If you tell DeLuxe to insert a bookmark, it will
  60.   recreate the QWK, saving any changes that were made.  Note: you can
  61.   represent the Q-WORK directory as %W\Q-WORK.  If you do this, enter the
  62.   batch file name as "BAT:UNPACK.BAT" (without quotes) when reconfiguring
  63.   DeLuxe.
  64.  
  65.   You can delete the lines "if exist [work_dir]\pruned.flg goto endit" and
  66.   "echo PRUNED > pruned.flg" from UNPACK.BAT.
  67.  
  68.                                  1stReader
  69.                                    -----
  70.   Copy FIRST.BAT to the directory where 1stReader is located and rename it
  71.   $$INTRO.BAT.  If you already have an $$INTRO.BAT, insert the line
  72.   "qwkprune /m%2" (without quotes) into it.  %2 represents the the work
  73.   directory defined in 1stReader's setup.
  74.  
  75.   If the "Use Bookmark" switch in 1stReader's setup is ON, you can usually
  76.   save any changes by telling 1stReader that you want to insert a bookmark.
  77.   According to Mark Herring, 1stReader won't repack QWK packets that came
  78.   from a Qmail door with option #21 turned on.  You can also use SAVEQWK
  79.   (see ADDON.DOC) to save the changes.
  80.  
  81.   Note that, if $$INTRO.BAT exists, 1stReader automatically runs it after
  82.   the QWK is unpacked.  There's no need to change 1stReader's setup.
  83.  
  84.                                   KingQWK
  85.                                    -----
  86.   Use UNPACK.BAT.  If you're using version 1.05, and KingQWK is not
  87.   configured to swap, you can enter the name as "UNPACK.BAT" (without
  88.   quotes).  Otherwise, use COMMAND /C or PARM.  If KingQWK is configured to
  89.   swap, enter these names as COMMAND.COM /C or PARM.EXE.  Users of version
  90.   1.05 can save changes by killing a message in KingQWK, then unkilling it.
  91.   It appears that this is enough to get KingQWK to ask if you want to
  92.   delete killed messages from the QWK packet.
  93.  
  94.   Versions of KingQWK prior to 1.05 will automatically re-archive
  95.   MESSAGES.DAT if it's been changed, even if it wasn't changed by KingQWK.
  96.   However, the changed .NDX files won't be re-archived.  You should
  97.   reconfigure KingQWK to use KQ-PACK.BAT to call your unpacker.
  98.  
  99.                                   QWKMerge
  100.                                    -----
  101.   Use QWKM.BAT.  If you're using version 1.05, and QWKMerge is not
  102.   configured to swap, you can enter the name as "QWKM.BAT" (without quotes)
  103.   Otherwise, use COMMAND /C or PARM.  If QWKMerge is configured to swap,
  104.   enter these names as COMMAND.COM /C or PARM.EXE.
  105.  
  106.   Thanks to Mike King for mentioning that version 1.05 of KingQWK and
  107.   QWKMerge can call batch files directly under some conditions.
  108.  
  109.   The configuration programs for KingQWK and QWKMerge don't allow the
  110.   command lines for packers and unpackers to be very long.  You may want to
  111.   give the batch files shorter names.  If you use PARM, you should be able
  112.   to fit the command lines for most unpackers into the allotted space, though
  113.   you may need to give PARM.EXE a shorter name.  If you can't fit the name
  114.   of an unpacker into the available space, make a copy of the batch file,
  115.   and place the name of the unpacker, along with any needed switches in
  116.   front of the "%1 %2 %3 %4 %5 %6 %7 %8 %9" line.
  117.  
  118.   Note: On some systems, KingQWK and QWKmerge may lock up when swapping in
  119.   from EMS.  Swapping to disk or XMS works OK.  This doesn't appear to be
  120.   related to QWKPRUNE.  At least, it happens whether or not QWKPRUNE is
  121.   being run while KingQWK or QWKMerge is swapped.
  122.  
  123.   If you have this problem, turn swapping off and try using a third-party
  124.   swapper.  I've gotten SHROOM to work with the "-t *" switch provided that
  125.   packers and unpackers are entered without extensions.  I've also had
  126.   success using SWAPDOS to swap to EMS.
  127.  
  128.                                 Jabber 1.1+
  129.                                    -----
  130.   Use UNPACK.BAT.  When editing the unpacking commands in Jabber's
  131.   configuration file, enter the name as "UNPACK.BAT" (without quotes).
  132.   Note that the .BAT extension must be given, or Jabber won't know that
  133.   it's to call a batch file.   Thanks to John Erickson for pointing this
  134.   out.
  135.  
  136.   Also, the command lines for unpackers must not contain slashes or
  137.   backslashes.  It appears that confuses Jabber, and causes the parameters
  138.   to be passed incorrectly.
  139.  
  140.   Jabber changes to its work directory when unpacking a QWK, so references
  141.   to the work directory can be removed from UNPACK.BAT.  If you do this,
  142.   you can also delete the lines "if exist [work_dir]\pruned.flg goto endit"
  143.   and "echo PRUNED > pruned.flg" from UNPACK.BAT.
  144.  
  145.                             Session Manager 1.06
  146.                                    -----
  147.   Use SMAN.BAT.  Session Manager can call batch files directly, but doesn't
  148.   accept parameters for the programs it runs to pack and unpack QWK files.
  149.   If you tell Session Manager to save the current session, it repacks the
  150.   .NDX files and MESSAGES.DAT, so you can save the changes.  If an entire
  151.   conference is pruned out, and you didn't delete the QWK after unpacking
  152.   it, the old .NDX for that conference will be kept.  While that conference
  153.   will be garbled, the rest of the packet should still be readable.  Still,
  154.   I suggest manually deleting the QWK file if you plan to save the session
  155.   and think all messages in a conference were pruned out.
  156.  
  157.                                MegaMail 2.10
  158.                                    -----
  159.   Use MEGA.BAT.  The MegaMail reader can't use a batch file to call an
  160.   unpacker, nor can it pass parameters to an executable file.  However, its
  161.   /nozip and /import switches will let you import messages from a packet
  162.   that's been unpacked.  To import all packets in your download directory,
  163.   create a batch file containing this line:
  164.  
  165.   for %%f in ([down_dir]\.qw*) do call mega %%f
  166.  
  167.   Replace [down_dir] with the full path of the directory your QWK packets
  168.   are stored in, and remove all occurrences of [down_dir] from MEGA.BAT.
  169.   Note: call wasn't present in DOS versions earlier than 3.3.  Users of
  170.   these versions use COMMAND /C instead.
  171.  
  172.                                Power-QWK 2.14
  173.                                    -----
  174.   Use PARM.EXE and UNPACK.BAT.  In Power-QWK's configuration, put
  175.   "PARM.EXE ..\UNPACK" (without quotes) in front of the name of your
  176.   unpacker.  Power-QWK's configuration program will locate PARM.EXE, and
  177.   expand the filename to include the full path.
  178.  
  179.   When unpacking a QWK, Power-QWK creates its work directory under the
  180.   program directory and changes to it.  While you don't need to include the
  181.   work directory in UNPACK.BAT, you do need to say where UNPACK.BAT is.
  182.  
  183.   You can delete the lines "if exist [work_dir]\pruned.flg goto endit" and
  184.   "echo PRUNED > pruned.flg" from UNPACK.BAT.
  185.  
  186.                               Speed Read 1.20
  187.                                    -----
  188.   Use UNPACK.BAT.  Speed can't call batch files directly, use COMMAND /C or
  189.   PARM.  Speed Read changes to its work directory, so there's no need to
  190.   refer to the work directory in UNPACK.BAT.  You do have to tell Speed
  191.   Read where UNPACK.BAT is.  Be sure to keep the "if exist messages.dat"
  192.   line, as Speed Read calls unpackers at other times than when it unpacks
  193.   QWKs.
  194.  
  195.   You can delete the lines "if exist [work_dir]\pruned.flg goto endit" and
  196.   "echo PRUNED > pruned.flg" from UNPACK.BAT.
  197.  
  198.   Note: On some systems, Speed Read may lock up when swapping in from EMS.
  199.   Swapping to disk or XMS works OK.  This doesn't appear to be related to
  200.   QWKPRUNE.  At least, it happens whether or not QWKPRUNE is being run
  201.   while Speed Read is swapped.
  202.  
  203.   If you have this problem, turn swapping off and try using a third-party
  204.   swapper.  SHROOM appears to work well.
  205.  
  206.                                Blue Wave 2.1x
  207.                                    -----
  208.   Use UNPACK.BAT.  When editing the unpacking commands in Blue Wave's
  209.   configuration, enter the name as "UNPACK.BAT" (without quotes).  Note
  210.   that the >BAT extension must be given, or Blue Wave won't know that it's
  211.   to call a batch file.  Blue Wave doesn't change to its work directory, so
  212.   you'll have to specify it in UNPACK.BAT.  Be sure to keep the 
  213.   "if exist [work_dir]\messages.dat" line, as it should keep QWKPRUNE from
  214.   being run if a Blue Wave packet is being unpacked.  You may want to check
  215.   for .NDX files instead.
  216.  
  217.  
  218.                                    -----
  219.   Some readers have substitution variables that can be used in function key
  220.   definitions or menu entries.  If your reader is one of these, you can use
  221.   them to add entries to a prune file from within the reader.  The output
  222.   can be generated either by DOS's ECHO command and output redirection, or
  223.   by MKPRN.EXE (see ADDON.DOC).  For example, a function key in SLMR could
  224.   be configured as: NOSWAP:echo @CONFNUM@,F:@FROM@ >> e:\@BBSID@.prn.
  225.  
  226.   Redirection is slightly faster than MKPRN, but doesn't work right if
  227.   the text being echoed contains the DOS redirection or pipe characters
  228.   <, >, and |.
  229.  
  230.   When setting up such commands, you should give a path to the prune file,
  231.   so as to say where you want it to be.
  232.